DLR Receipts

A callback is an HTTP POST request with a notification made by the Sinch India Conversation API to a URI of your choosing.

Delivery Report Fields

Field	Type	Description
message_id	string	The ID of the app message
conversation_id	string	The ID of the conversation. Empty if processing_mode is DISPATCH
status	string	The delivery status
channel_identity	object	The identity of the contact in the underlying channel
contact_id	string	The ID of the contact. Empty if processing_mode is DISPATCH
reason	object	Error reason if status is FAILED or SWITCHING_CHANNEL
metadata	string	Metadata specified in the send request
processing_mode	string	Currently only DISPATCH mode is supported

Delivery Status Values

Status	Description
QUEUED_ON_CHANNEL	Message successfully dispatched to the underlying channel
DELIVERED	Message has reached the end user
READ	Message was seen or read by the end user (terminal state)
FAILED	Delivery failed with no more channels to try (terminal state)
SWITCHING_CHANNEL	Delivery failed but more channels are available to try

Sample DLR — Delivered

{
  "app_id": "01H0MFFJFX0YAWYA5XG4D3MRTA",
  "accepted_time": "2023-06-13T09:48:57.319Z",
  "event_time": "2023-06-13T09:49:00.887336Z",
  "project_id": "517ccc41-7c1a-4dfe-af03-dfe804116121",
  "message_delivery_report": {
    "message_id": "01H2T2H437XD18TAFQJYBKJM4C",
    "conversation_id": "",
    "status": "DELIVERED",
    "channel_identity": {
      "channel": "RCS",
      "identity": "916284458847",
      "app_id": "01H0MFFJFX0YAWYA5XG4D3MRTA"
    },
    "contact_id": "",
    "metadata": "",
    "processing_mode": "DISPATCH"
  },
  "message_metadata": ""
}

Sample DLR — Failed

{
  "app_id": "01H0MFFJFX0YAWYA5XG4D3MRTA",
  "message_delivery_report": {
    "message_id": "01H2T2J9SJBQM8B27A0CMGCNCD",
    "status": "FAILED",
    "channel_identity": { "channel": "RCS", "identity": "919319304893", "app_id": "01H0MFFJFX0YAWYA5XG4D3MRTA" },
    "reason": {
      "code": "UNKNOWN",
      "description": "The underlying channel reported: Unknown channel error",
      "sub_code": "UNSPECIFIED_SUB_CODE"
    },
    "processing_mode": "DISPATCH"
  }
}

RCS Failure Error Messages

Error Type	Reason
Invalid Template	User is not in a conversation and the template is not approved
Opted Out	opted_out
Curfew Hours	curfew_hrs
Message Limit	Monthly message limit exceeded
RCS Disabled	Number is RCS disabled
Internal Server Error	Specific internal server error
4xx MAAP Errors	MAAP-specific error